Upgrade Smart Integration Connector

The following section describes how to upgrade Smart Integration Connector.

IMPORTANT: The Smart Integration Connector Local Gateway Server version 8.5 is required to use with OneStream 8.5. Previous versions of Local Gateway Server will not communicate with OneStream 8.5. Upgrade your Local Gateway Server to v8.5 to continue using Smart Integration Connector.

Upgrade from

  • Private Preview versions 7.2, 7.3,

  • Limited Availability version 7.4, or

  • General Availability versions 8.x to 8.4

As part of the upgrade, you can expect the following:

  • A copy of the original configuration file from the prior version will be saved.

  • Existing gateways should continue to function as they did prior to the install.

  • If the Smart Integration Connector Windows Service is running, then the service will automatically be started after install.

    IMPORTANT: OneStream 8.5 will only communicate with Smart Integration Connector Local Gateway Server 8.5.

If you perform an upgrade and have issues or do not achieve these results, contact OneStream Support.

  1. Install the latest version of OneStream. The latest version can be requested and scheduled through the OneStream Software Cloud Customer Service Catalog. Make a note in the details section of the ticket that you want to install and configure the Smart Integration Connector.

  2. Download the Smart Integration Connector install (OneStream_Connector_#.#.#.zip) file from the Platform section of the Solution Exchange.

  3. Extract the OneStreamSmartIntegrationConnectorGateway-#.#.#.#####.msi from the downloaded zip file.

  4. Back up a copy of your configuration folder and sub folders before upgrading. Default is: C:\Program Files\OneStream Software\OneStream Gateway\.

  5. Follow the steps in Setup and Installation to complete your upgrade.

    NOTE: If the upgrade process is interrupted or canceled, the Smart Integration Connector must be reinstalled.

If the Smart Integration Connector Windows Service was configured to start using a custom service account prior to upgrading, confirm that the service is set to start using the correct service account after the upgrade is completed.

NOTE: For OneStream Local Gateway Server version 8.1 and above, the new default location for Reference Assembly Folder is C:\Program Files\OneStream Software\OneStream Gateway\Referenced Assemblies.

Prior to v8.0, it was required that a OneStream Business Rule developer invoking a remote Smart Integration Function be aware of the data type returned and convert accordingly after the result is returned.

Example: An example where the returned result was a byte array involved code that appeared as follows:

Copy 
bytesFromFile = CompressionHelper.InflateJsonObject(Of System.Byte())
(si,objRemoteRequestResultDto.resultDataCompressed)

The Smart Integration Connector Gateway now provides this type of information back to OneStream and streamlines this conversion process using a newly added property called ObjectResultValue, which is populated.

When invoking the same operation shown above that previously required the type to be converted, a BR developer can do the following:

Copy 
bytesFromFile = objRemoteRequestResultDto.ObjectResultValue
Copy 
bytesFromFile = CompressionHelper.InflateJsonObject(Of System.Byte())
(si,objRemoteRequestResultDto.resultDataCompressed)
Copy 
bytesFromFile = objRemoteRequestResultDto.ObjectResultValue